home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / accessibility / nsIAccessNode.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  12KB  |  307 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIAccessNode.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIAccessNode_h__
  6. #define __gen_nsIAccessNode_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDOMNode; /* forward declaration */
  18.  
  19. class nsIAccessibleDocument; /* forward declaration */
  20.  
  21.  
  22. /* starting interface:    nsIAccessNode */
  23. #define NS_IACCESSNODE_IID_STR "46820f9b-3088-4046-ab0f-56fdacdc7a82"
  24.  
  25. #define NS_IACCESSNODE_IID \
  26.   {0x46820f9b, 0x3088, 0x4046, \
  27.     { 0xab, 0x0f, 0x56, 0xfd, 0xac, 0xdc, 0x7a, 0x82 }}
  28.  
  29. /**
  30.  * An interface used by in-process accessibility clients
  31.  * to get style, window, markup and other information about
  32.  * a DOM node. When accessibility is active in Gecko,
  33.  * every DOM node can have one nsIAccessNode for each
  34.  * pres shell the DOM node is rendered in.
  35.  * The nsIAccessNode implementations are instantiated lazily.
  36.  * The nsIAccessNode tree for a given dom window
  37.  * has a one to one relationship to the DOM tree.
  38.  * If the DOM node for this access node is "accessible",
  39.  * then a QueryInterface to nsIAccessible will succeed.
  40.  *
  41.  * @status UNDER_REVIEW
  42.  */
  43. class NS_NO_VTABLE nsIAccessNode : public nsISupports {
  44.  public: 
  45.  
  46.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IACCESSNODE_IID)
  47.  
  48.   /**
  49.    * The DOM node this nsIAccessNode is associated with.
  50.    */
  51.   /* readonly attribute nsIDOMNode DOMNode; */
  52.   NS_IMETHOD GetDOMNode(nsIDOMNode * *aDOMNode) = 0;
  53.  
  54.   /**
  55.    * The number of DOM children for the DOM node, which
  56.    * matches the number of nsIAccessNode children for this
  57.    * nsIAccessNode.
  58.    */
  59.   /* readonly attribute long numChildren; */
  60.   NS_IMETHOD GetNumChildren(PRInt32 *aNumChildren) = 0;
  61.  
  62.   /**
  63.    * Get the nth child of this node
  64.    * @param childNum Zero-based child index
  65.    * @return The nth nsIAccessNode child
  66.    */
  67.   /* nsIAccessNode getChildNodeAt (in long childNum); */
  68.   NS_IMETHOD GetChildNodeAt(PRInt32 childNum, nsIAccessNode **_retval) = 0;
  69.  
  70.   /**
  71.    * The parent nsIAccessNode
  72.    */
  73.   /* readonly attribute nsIAccessNode parentNode; */
  74.   NS_IMETHOD GetParentNode(nsIAccessNode * *aParentNode) = 0;
  75.  
  76.   /**
  77.    * The first nsIAccessNode child
  78.    */
  79.   /* readonly attribute nsIAccessNode firstChildNode; */
  80.   NS_IMETHOD GetFirstChildNode(nsIAccessNode * *aFirstChildNode) = 0;
  81.  
  82.   /**
  83.    * The last nsIAccessNode child
  84.    */
  85.   /* readonly attribute nsIAccessNode lastChildNode; */
  86.   NS_IMETHOD GetLastChildNode(nsIAccessNode * *aLastChildNode) = 0;
  87.  
  88.   /**
  89.    * The previous nsIAccessNode sibling
  90.    */
  91.   /* readonly attribute nsIAccessNode previousSiblingNode; */
  92.   NS_IMETHOD GetPreviousSiblingNode(nsIAccessNode * *aPreviousSiblingNode) = 0;
  93.  
  94.   /**
  95.    * The next nsIAccessNode sibling
  96.    */
  97.   /* readonly attribute nsIAccessNode nextSiblingNode; */
  98.   NS_IMETHOD GetNextSiblingNode(nsIAccessNode * *aNextSiblingNode) = 0;
  99.  
  100.   /**
  101.    * The nsIAccessibleDocument that this nsIAccessNode
  102.    * resides in.
  103.    */
  104.   /* readonly attribute nsIAccessibleDocument accessibleDocument; */
  105.   NS_IMETHOD GetAccessibleDocument(nsIAccessibleDocument * *aAccessibleDocument) = 0;
  106.  
  107.   /**
  108.    * The innerHTML for the DOM node
  109.    * This is a text string of all the markup inside the DOM
  110.    * node, not including the start and end tag for the node.
  111.    */
  112.   /* readonly attribute DOMString innerHTML; */
  113.   NS_IMETHOD GetInnerHTML(nsAString & aInnerHTML) = 0;
  114.  
  115.   /**
  116.    * The OS window handle for the window this node
  117.    * is being displayed in.
  118.    */
  119.   /* [noscript] readonly attribute voidPtr ownerWindow; */
  120.   NS_IMETHOD GetOwnerWindow(void * *aOwnerWindow) = 0;
  121.  
  122.   /**
  123.    * A unique ID calculated for this DOM node, for the 
  124.    * purposes of caching and referencing this object.
  125.    */
  126.   /* [noscript] readonly attribute voidPtr uniqueID; */
  127.   NS_IMETHOD GetUniqueID(void * *aUniqueID) = 0;
  128.  
  129.   /**
  130.    * Retrieve the computed style value for this DOM node, if it is a DOM element.
  131.    * Note: the meanings of width, height and other size measurements depend
  132.    * on the version of CSS being used. Therefore, for bounds information, 
  133.    * it is better to use nsIAccessible::accGetBounds.
  134.    * @param pseudoElt The pseudo element to retrieve style for, or NULL
  135.    *                  for general computed style information for this node.
  136.    * @param propertyName Retrieve the computed style value for this property name,
  137.    *                     for example "border-bottom".
  138.    */
  139.   /* DOMString getComputedStyleValue (in DOMString pseudoElt, in DOMString propertyName); */
  140.   NS_IMETHOD GetComputedStyleValue(const nsAString & pseudoElt, const nsAString & propertyName, nsAString & _retval) = 0;
  141.  
  142. };
  143.  
  144. /* Use this macro when declaring classes that implement this interface. */
  145. #define NS_DECL_NSIACCESSNODE \
  146.   NS_IMETHOD GetDOMNode(nsIDOMNode * *aDOMNode); \
  147.   NS_IMETHOD GetNumChildren(PRInt32 *aNumChildren); \
  148.   NS_IMETHOD GetChildNodeAt(PRInt32 childNum, nsIAccessNode **_retval); \
  149.   NS_IMETHOD GetParentNode(nsIAccessNode * *aParentNode); \
  150.   NS_IMETHOD GetFirstChildNode(nsIAccessNode * *aFirstChildNode); \
  151.   NS_IMETHOD GetLastChildNode(nsIAccessNode * *aLastChildNode); \
  152.   NS_IMETHOD GetPreviousSiblingNode(nsIAccessNode * *aPreviousSiblingNode); \
  153.   NS_IMETHOD GetNextSiblingNode(nsIAccessNode * *aNextSiblingNode); \
  154.   NS_IMETHOD GetAccessibleDocument(nsIAccessibleDocument * *aAccessibleDocument); \
  155.   NS_IMETHOD GetInnerHTML(nsAString & aInnerHTML); \
  156.   NS_IMETHOD GetOwnerWindow(void * *aOwnerWindow); \
  157.   NS_IMETHOD GetUniqueID(void * *aUniqueID); \
  158.   NS_IMETHOD GetComputedStyleValue(const nsAString & pseudoElt, const nsAString & propertyName, nsAString & _retval); 
  159.  
  160. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  161. #define NS_FORWARD_NSIACCESSNODE(_to) \
  162.   NS_IMETHOD GetDOMNode(nsIDOMNode * *aDOMNode) { return _to GetDOMNode(aDOMNode); } \
  163.   NS_IMETHOD GetNumChildren(PRInt32 *aNumChildren) { return _to GetNumChildren(aNumChildren); } \
  164.   NS_IMETHOD GetChildNodeAt(PRInt32 childNum, nsIAccessNode **_retval) { return _to GetChildNodeAt(childNum, _retval); } \
  165.   NS_IMETHOD GetParentNode(nsIAccessNode * *aParentNode) { return _to GetParentNode(aParentNode); } \
  166.   NS_IMETHOD GetFirstChildNode(nsIAccessNode * *aFirstChildNode) { return _to GetFirstChildNode(aFirstChildNode); } \
  167.   NS_IMETHOD GetLastChildNode(nsIAccessNode * *aLastChildNode) { return _to GetLastChildNode(aLastChildNode); } \
  168.   NS_IMETHOD GetPreviousSiblingNode(nsIAccessNode * *aPreviousSiblingNode) { return _to GetPreviousSiblingNode(aPreviousSiblingNode); } \
  169.   NS_IMETHOD GetNextSiblingNode(nsIAccessNode * *aNextSiblingNode) { return _to GetNextSiblingNode(aNextSiblingNode); } \
  170.   NS_IMETHOD GetAccessibleDocument(nsIAccessibleDocument * *aAccessibleDocument) { return _to GetAccessibleDocument(aAccessibleDocument); } \
  171.   NS_IMETHOD GetInnerHTML(nsAString & aInnerHTML) { return _to GetInnerHTML(aInnerHTML); } \
  172.   NS_IMETHOD GetOwnerWindow(void * *aOwnerWindow) { return _to GetOwnerWindow(aOwnerWindow); } \
  173.   NS_IMETHOD GetUniqueID(void * *aUniqueID) { return _to GetUniqueID(aUniqueID); } \
  174.   NS_IMETHOD GetComputedStyleValue(const nsAString & pseudoElt, const nsAString & propertyName, nsAString & _retval) { return _to GetComputedStyleValue(pseudoElt, propertyName, _retval); } 
  175.  
  176. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  177. #define NS_FORWARD_SAFE_NSIACCESSNODE(_to) \
  178.   NS_IMETHOD GetDOMNode(nsIDOMNode * *aDOMNode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDOMNode(aDOMNode); } \
  179.   NS_IMETHOD GetNumChildren(PRInt32 *aNumChildren) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNumChildren(aNumChildren); } \
  180.   NS_IMETHOD GetChildNodeAt(PRInt32 childNum, nsIAccessNode **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetChildNodeAt(childNum, _retval); } \
  181.   NS_IMETHOD GetParentNode(nsIAccessNode * *aParentNode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetParentNode(aParentNode); } \
  182.   NS_IMETHOD GetFirstChildNode(nsIAccessNode * *aFirstChildNode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFirstChildNode(aFirstChildNode); } \
  183.   NS_IMETHOD GetLastChildNode(nsIAccessNode * *aLastChildNode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLastChildNode(aLastChildNode); } \
  184.   NS_IMETHOD GetPreviousSiblingNode(nsIAccessNode * *aPreviousSiblingNode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPreviousSiblingNode(aPreviousSiblingNode); } \
  185.   NS_IMETHOD GetNextSiblingNode(nsIAccessNode * *aNextSiblingNode) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNextSiblingNode(aNextSiblingNode); } \
  186.   NS_IMETHOD GetAccessibleDocument(nsIAccessibleDocument * *aAccessibleDocument) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAccessibleDocument(aAccessibleDocument); } \
  187.   NS_IMETHOD GetInnerHTML(nsAString & aInnerHTML) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetInnerHTML(aInnerHTML); } \
  188.   NS_IMETHOD GetOwnerWindow(void * *aOwnerWindow) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetOwnerWindow(aOwnerWindow); } \
  189.   NS_IMETHOD GetUniqueID(void * *aUniqueID) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetUniqueID(aUniqueID); } \
  190.   NS_IMETHOD GetComputedStyleValue(const nsAString & pseudoElt, const nsAString & propertyName, nsAString & _retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetComputedStyleValue(pseudoElt, propertyName, _retval); } 
  191.  
  192. #if 0
  193. /* Use the code below as a template for the implementation class for this interface. */
  194.  
  195. /* Header file */
  196. class nsAccessNode : public nsIAccessNode
  197. {
  198. public:
  199.   NS_DECL_ISUPPORTS
  200.   NS_DECL_NSIACCESSNODE
  201.  
  202.   nsAccessNode();
  203.  
  204. private:
  205.   ~nsAccessNode();
  206.  
  207. protected:
  208.   /* additional members */
  209. };
  210.  
  211. /* Implementation file */
  212. NS_IMPL_ISUPPORTS1(nsAccessNode, nsIAccessNode)
  213.  
  214. nsAccessNode::nsAccessNode()
  215. {
  216.   /* member initializers and constructor code */
  217. }
  218.  
  219. nsAccessNode::~nsAccessNode()
  220. {
  221.   /* destructor code */
  222. }
  223.  
  224. /* readonly attribute nsIDOMNode DOMNode; */
  225. NS_IMETHODIMP nsAccessNode::GetDOMNode(nsIDOMNode * *aDOMNode)
  226. {
  227.     return NS_ERROR_NOT_IMPLEMENTED;
  228. }
  229.  
  230. /* readonly attribute long numChildren; */
  231. NS_IMETHODIMP nsAccessNode::GetNumChildren(PRInt32 *aNumChildren)
  232. {
  233.     return NS_ERROR_NOT_IMPLEMENTED;
  234. }
  235.  
  236. /* nsIAccessNode getChildNodeAt (in long childNum); */
  237. NS_IMETHODIMP nsAccessNode::GetChildNodeAt(PRInt32 childNum, nsIAccessNode **_retval)
  238. {
  239.     return NS_ERROR_NOT_IMPLEMENTED;
  240. }
  241.  
  242. /* readonly attribute nsIAccessNode parentNode; */
  243. NS_IMETHODIMP nsAccessNode::GetParentNode(nsIAccessNode * *aParentNode)
  244. {
  245.     return NS_ERROR_NOT_IMPLEMENTED;
  246. }
  247.  
  248. /* readonly attribute nsIAccessNode firstChildNode; */
  249. NS_IMETHODIMP nsAccessNode::GetFirstChildNode(nsIAccessNode * *aFirstChildNode)
  250. {
  251.     return NS_ERROR_NOT_IMPLEMENTED;
  252. }
  253.  
  254. /* readonly attribute nsIAccessNode lastChildNode; */
  255. NS_IMETHODIMP nsAccessNode::GetLastChildNode(nsIAccessNode * *aLastChildNode)
  256. {
  257.     return NS_ERROR_NOT_IMPLEMENTED;
  258. }
  259.  
  260. /* readonly attribute nsIAccessNode previousSiblingNode; */
  261. NS_IMETHODIMP nsAccessNode::GetPreviousSiblingNode(nsIAccessNode * *aPreviousSiblingNode)
  262. {
  263.     return NS_ERROR_NOT_IMPLEMENTED;
  264. }
  265.  
  266. /* readonly attribute nsIAccessNode nextSiblingNode; */
  267. NS_IMETHODIMP nsAccessNode::GetNextSiblingNode(nsIAccessNode * *aNextSiblingNode)
  268. {
  269.     return NS_ERROR_NOT_IMPLEMENTED;
  270. }
  271.  
  272. /* readonly attribute nsIAccessibleDocument accessibleDocument; */
  273. NS_IMETHODIMP nsAccessNode::GetAccessibleDocument(nsIAccessibleDocument * *aAccessibleDocument)
  274. {
  275.     return NS_ERROR_NOT_IMPLEMENTED;
  276. }
  277.  
  278. /* readonly attribute DOMString innerHTML; */
  279. NS_IMETHODIMP nsAccessNode::GetInnerHTML(nsAString & aInnerHTML)
  280. {
  281.     return NS_ERROR_NOT_IMPLEMENTED;
  282. }
  283.  
  284. /* [noscript] readonly attribute voidPtr ownerWindow; */
  285. NS_IMETHODIMP nsAccessNode::GetOwnerWindow(void * *aOwnerWindow)
  286. {
  287.     return NS_ERROR_NOT_IMPLEMENTED;
  288. }
  289.  
  290. /* [noscript] readonly attribute voidPtr uniqueID; */
  291. NS_IMETHODIMP nsAccessNode::GetUniqueID(void * *aUniqueID)
  292. {
  293.     return NS_ERROR_NOT_IMPLEMENTED;
  294. }
  295.  
  296. /* DOMString getComputedStyleValue (in DOMString pseudoElt, in DOMString propertyName); */
  297. NS_IMETHODIMP nsAccessNode::GetComputedStyleValue(const nsAString & pseudoElt, const nsAString & propertyName, nsAString & _retval)
  298. {
  299.     return NS_ERROR_NOT_IMPLEMENTED;
  300. }
  301.  
  302. /* End of implementation class template. */
  303. #endif
  304.  
  305.  
  306. #endif /* __gen_nsIAccessNode_h__ */
  307.